home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1996 #5 / Amiga Plus CD - 1996 - No. 5.iso / pd / grafik / jacosub / documentation / overview.doc < prev    next >
Encoding:
Text File  |  1996-06-02  |  32.4 KB  |  717 lines

  1.           JACOsub: video titling software for professionals
  2.                             version 2.5
  3.                Timed Script Editor, Timer, and Player
  4.              A Product from Unicorn Research Corporation
  5.  
  6.  
  7. This document provides an overview of the JACOsub software package
  8. (features, installation, compatibility, script conversion, and product
  9. support).  Be sure to read the product support section concerning bug
  10. reports, if you don't read anything else.  Other documentation files in
  11. this package are:
  12.  
  13.    JACOsub.doc  - Information on operating the program.
  14.    JScripts.doc - Detailed information on the JACOsub script format
  15.                   specification.
  16.    ARexx.doc    - Covers ARexx communications with JACOsub.
  17.    QuickRef.doc - Quick reference for script commands and directives.
  18.    FAQ          - Some Frequently Asked Questions, with answers.
  19.    Register.doc - Information about registering the software.
  20.  
  21. CONTENTS OF THIS DOCUMENT
  22. =========================
  23.  
  24.  1.  What is JACOsub?
  25.  2.  Special features of JACOsub
  26.  3.  System requirements
  27.  4.  Installation
  28.      a.  General information
  29.      b.  Installation on SINGLE-DRIVE systems
  30.  5.  Interactions with other software and hardware
  31.  6.  Genlock support
  32.  7.  ARexx support (see ARexx.doc)
  33.  8.  JConvert script conversion utility
  34.  9.  JACOsub script file format specification (see JScripts.doc)
  35. 10.  Shareware registration / commercial licensing (see register.doc)
  36. 11.  Legal disclaimer
  37. 12.  Support, technical questions, suggestions, bug reports
  38. 13.  KNOWN BUGS -- PLEASE HELP
  39.  
  40.  
  41. 1.  WHAT IS JACOsub?
  42. ====================
  43.  
  44. JACOsub is a program designed for displaying timed sequences of titles and
  45. graphics over a video.  Professional-quality output and flexibility have
  46. been the primary goals since the program's inception.  It was originally
  47. written for the Japanese Animation Club of Orlando (JACO) to lay English
  48. subtitles over Japanese-language films and television shows.  The program
  49. has spread and grown in popularity due to its extremely flexible script
  50. format, clean multi-buffered title transitions, and other features
  51. described in the next section.
  52.  
  53. The development of JACOsub has been primarily user-driven.  Most of the
  54. program's more interesting features exist because users suggested them.
  55. Because of the valuable input given by so many people, JACOsub has become
  56. an exceptionally powerful program while retaining its initial simplicity
  57. at the same time.
  58.  
  59.  
  60. 2.  SPECIAL FEATURES OF JACOsub
  61. ===============================
  62.  
  63.  *  Non-sequential events.  Title time ranges may overlap.  Unlimited
  64.     indepenedent title sequences may be displayed simultaneously.
  65.  
  66.  *  Fully integrated text-based script editor with optional user interface
  67.     for title appearance attributes.  If needed, video titles may be
  68.     positioned graphically with the mouse.
  69.  
  70.  *  Handles all kinds of time units: SMPTE, PAL, 1/100 second units, etc.
  71.  
  72.  *  Extremely flexible timing script file format, allowing comments, blank
  73.     lines, text directives, and global configuration commands.  Scripts can
  74.     be as simple or as complex as you want.  Scripts may even include other
  75.     scripts, so you don't have to re-time parts that you use over and over
  76.     again.
  77.  
  78.  *  Complete script-based control over text position, margins, font, style,
  79.     colors, palettes, backshadow, word-wrapping, and justification.  You
  80.     can even generate anti-aliased outlines and shadows on mono-color text.
  81.     Text appearance can be controlled through line directives or with
  82.     C-style escape code inside the subtitle text.
  83.  
  84.  *  Real-time script timing procedure allows you to time your script in
  85.     small sections, and in independent tracks.  The program offers
  86.     intelligent calculation of title end times and forced gaps, leaving you
  87.     free to concentrate only on title start times during timing.  End times
  88.     may be also timed separately from start times.
  89.  
  90.  *  Display graphic images with the text.  Time ranges for graphic images
  91.     may overlap also.  Graphics (IFF pictures or brushes) may be positioned
  92.     anywhere on the screen.  If you do not need to generate text over
  93.     graphics, you can load IFF pictures independently of JACOsub's display.
  94.     JACOsub supports AGA graphics.
  95.  
  96.  *  Support for transition effects (for example, wipe, iris, blinds, roll),
  97.     and smooth scrolling titles.
  98.  
  99.  *  Multi video buffering and page switching.  Many titling programs create
  100.     a display in a hidden buffer, then blit it to the visible foreground at
  101.     the proper time.  But the duration of a multi-bitplane blit can be up
  102.     to 3 video frames.  This can cause disconcerting "flashing" or tearing
  103.     effects.  Many PD/shareware titling programs have this problem.
  104.     JACOsub has a better way:  It uses video-page switching rather than
  105.     blitting, to move displays to the foreground.  Images appear
  106.     instantaneously during the vertical CRT blank interval.  Blitting is
  107.     only used to copy data between up to 7 hidden video buffers, never on
  108.     the visible display.
  109.  
  110.  *  You can make time shift and drift adjustments "on the fly" while your
  111.     script is playing.
  112.  
  113.  *  ARexx support -- other programs can issue commands to JACOsub, and your
  114.     JACOsub scripts can execute ARexx scripts while playing.  You can even
  115.     control JACOsub's editor through ARexx.
  116.  
  117.  *  You can control the Digital Creations SuperGen genlock faders directly
  118.     from your script!  GVP and Video Toaster genlock fades may be
  119.     controlled indirectly through ARexx scripts.
  120.  
  121.  *  Robust compiler diagnostics for tracking down problems in your scripts.
  122.  
  123.  *  Support for 3rd-party script formats:  TurboTitle (.tts), Phoenix
  124.     Japanimation Society (.pjs), generic (.tim), Panimator (.pan), Subtitle
  125.     (.sub), ZeroG (.zeg), and MacSubtitler (.scr).  The Jconvert utility is
  126.     provided to convert all these formats to JACOsub (.js) format.  JACOsub
  127.     can read .tts, .pjs, and .tim scripts without prior conversion.
  128.  
  129.  
  130. Author:  Alex Matulich
  131.          1515 Jefferson Davis Hwy #820
  132.          Arlington, VA 22202-3311
  133.          (703) 413-0215
  134.          email: matulich_a@SEAA.NAVSEA.NAVY.MIL
  135.  
  136. Original Beta Testers:
  137.          Fred A. Leggett III (JACO), Daric Kozlowski (JACO)
  138.          Tom Perry (Phoenix Japanimation Society)
  139.          Noel Gamboa (Operation X)
  140.          Robert Lowrey (Central Anime)
  141.          Roger Ang, Jacob Ellis, Dave Fleming,
  142.          Mike Harlock, Tommy Hwang, Ed Sum
  143.  
  144. Compiler:  SAS Amiga C/C++ 6.51
  145. Computer:  Amiga 1000 (never say die!) with WorkBench 2.1
  146.            AmigaDOS 2.04 ROM hacked in, 2M FAST, 512K CHIP, 30MB C-Ltd HD
  147.  
  148.  
  149. 3.  SYSTEM REQUIREMENTS
  150. =======================
  151.  
  152. JACOsub will run on any model Amiga computer, either PAL or NTSC.
  153.  
  154. Recommended hardware requirements:
  155. * At least 1 megabyte RAM, _preferably_ more than 1.5 megabytes
  156. * Two storage devices (2 floppy drives, hard disk and floppy, or single
  157.   drive plus RAM disk [requires extra memory])
  158.  
  159. Recommended software requirements:
  160. * AmigaDOS 2.0 or greater (program WILL run under 1.3; see next section
  161.   for caveats concerning 1.3)
  162. * libs: directory should contain:
  163.   + asl.library or req.library (for file requesters)
  164.   + iffparse.library (for IFF file support; 1.3-compatible version exists)
  165.   + supergen.library and copinint.library (if you have a SuperGen genlock)
  166.   The program will still run without any of these libraries.
  167.  
  168. Additional hardware needed for video work:
  169. * Amiga-compatible genlock (for overlaying computer images onto video)
  170. * Source video device, preferably a laserdisc player
  171. * Videocassete recorder for making master recordings
  172. * Second video monitor is useful but not required.
  173.  
  174.  
  175. 4.  INSTALLATION
  176. ================
  177.  
  178. a. General information
  179. ----------------------
  180.  
  181. After extracting the archive you should have the files in the list below.
  182. An "I" in the first column indicates that the file has an icon (.info file)
  183. associated with it.
  184.  
  185. I  README.1st                  Quick install and run instructions
  186. I  CHANGES.TXT                 List of improvements and bug fixes
  187. I  InstallFonts                Installs JACOsub's fonts into fonts:
  188. I  JACOsub                     The timing script compiler & player
  189.    JACOsub.cfg                 Empty config file to replace older ones
  190. I  jconvert                    Conversion utility for 3rd-party scripts
  191.    proglogo.bbm/pcx            Initial graphic that appears in the editor
  192.    tips.txt                    Tips to display when program starts up
  193. I  documentation (subdirectory)
  194. I     Overview.doc             You're reading it now
  195. I     JACOsub.doc              Documentation on operating the software
  196. I     JScripts.doc             JACOsub Script file format specification
  197. I     ARexx.doc                ARexx communications documentation
  198. I     Register.doc             Shareware registration instructions
  199. I     FAQ                      Frequently-Asked Questions, with answers
  200.    fonts (subdirectory)
  201.       JACOsub.font             A few high-quality video titling fonts
  202.       JACOsub (subdirectory)
  203.          18                    18-pixel height monochrome font for clock
  204.          29.4C                 29-pixel international color outline font
  205.          32.4C                 32-pixel international outline/shadow font
  206.          36.4C                 36-pixel international outline/shadow font
  207.       JACOsub_mono.font        Mono-color fonts (same char sizes as color)
  208.       JACOsub_mono (subdirectory)
  209.          25                    Mono-color version of 29-pixel color font
  210.          32                    Mono-color version of 36-pixel color font
  211.       JACOsub_superhires.font  Titling font for use in SUPERHIRES mode
  212.       JACOsub_superhires (subdirectory)
  213.          36.4C                 SUPERHIRES color outline font
  214.    rexx (subdirectory)
  215.       abortplay.jsrx           Demo of ABORTPLAY ARexx command
  216.       begintime.jsrx           Demo of BEGINTIME ARexx command
  217.       loadscript.jsrx          Demo of LOADSCRIPT ARexx command
  218.       playsetup.jsrx           Demo of PLAYSETUP ARexx command
  219.       playstart.jsrx           Demo of PLAYSTART ARexx command
  220.       quit.jsrx                Demo of QUIT ARexx command
  221.       savescript.jsrx          Demo of SAVESCRIPT Arexx command
  222.       screentoback.jsrx        Demo of SCREENTOBACK ARexx command
  223.       screentofront.jsrx       Demo of SCREENTOFRONT ARexx command
  224.       etc...                   ...and various others described in ARexx.doc
  225. I  scripts (subdirectory)
  226. I     demo.js                  Demonstration script for JACOsub
  227. I     idemo.js                 Secondary script included by demo.js
  228. I     JACO.bbm/pcx             Graphic logo; IFF brush used by demo.js
  229. I     cycldemo.js              Demo script for color cycling
  230. I     helium.lbm/pcx           Graphic file used with cyclscrl.js
  231. I     scrldemo.js              Demo script for smooth scrolling titles
  232.  
  233. All you need to do to install the software after you extract the archive,
  234. is copy the supplied fonts to your fonts: directory.  To do this, simply
  235. double-click on the "InstallFonts" icon, or enter these commands from the
  236. JACOsub directory at a Shell prompt:
  237.  
  238.    copy fonts fonts: all       ;copy the supplied fonts
  239.    delete fonts all            ;delete the fonts directory created by the
  240.                                ;archive extraction.
  241.  
  242. THE JACOsub FONTS MUST BE IN YOUR FONTS: DIRECTORY PRIOR TO RUNNING THE
  243. PROGRAM FOR THE FIRST TIME.  The fonts get updated and improved
  244. periodically, so you should always re-install them if CHANGES.TXT indicates
  245. that it is necessary.  BE SURE YOUR SYSTEM CLOCK IS SET CORRECTLY BEFORE
  246. INSTALLING THE FONTS, because JACOsub checks the jacosub.font date to see
  247. if it's recent enough.
  248.  
  249. If you have a SuperGen genlock, you need to make sure that your LIBS:
  250. directory contains supergen.library and copinit.library.  If they are
  251. missing, you won't be able to control your SuperGen from JACOsub scripts.
  252.  
  253. Before you run the program, you should be aware of some issues concerning
  254. different versions of AmigaDOS:
  255.  
  256.    AmigaDOS 1.2:  You will not be able to run JACOsub with color fonts.
  257.    If you boot up with a 1.3 disk using 1.2 Kickstart, you may have better
  258.    luck.  In any case, upgrade to 1.3 or 2.0 as soon as you can.  Your
  259.    libs: directory should contain req.library.  JACOsub does not support
  260.    AmigaDOS 1.2; if it works at all, it is purely by accident.
  261.  
  262.    AmigaDOS 1.3:  You will need to load a Colortext driver prior to running
  263.    JACOsub.  A good Colortext driver by InterActive Softworks is supplied
  264.    with Deluxe Paint IV or Calligrapher.  If you don't load this driver,
  265.    you will see only single-colored characters while JACOsub runs.
  266. >> DO NOT USE ColorTextWedge 1.2 (supplied with TurboTitle) -- it forces
  267.    all text into JAM2 mode which chops up fonts having overlapping
  268.    dropshadows (such as the supplied JACOsub font).  Also, your libs:
  269.    directory should contain req.library, though it's not required.
  270. >> Under 1.3, JACOsub's IFF capabilities will be unavailable to you unless
  271.    you have a 1.3-compatible version of iffparse.library in your libs:
  272.    directory.  ARexx operations have a similar restriction under 1.3.
  273.  
  274.    AmigaDOS 2.x users do not need any special Colortext driver -- it's
  275.    built into the OS.  You don't need req.library, but your libs: directory
  276.    should contain the AmigaDOS asl.library.  It's a good idea to patch it
  277.    with the reqtools.library patch utility if you have it.  Under AmigaDOS
  278.    2.x, you will be unable to load files using AGA video modes.
  279.  
  280.    AmigaDOS 3.0 and above:  Should behave the same as AmigaDOS 2.x, except
  281.    that you can load IFF files in AGA graphic modes.
  282.  
  283. Now you're ready to begin.  Just click twice on JACOsub's program icon, or
  284. type "run jacosub" from a Shell prompt.  Refer to JACOsub.doc for more
  285. detailed information on operating the program.
  286.  
  287. b.  Installation on single-drive systems
  288. ----------------------------------------
  289.  
  290. This procedure requires some knowledge of the AmigaDOS Shell.
  291.  
  292. If your computer's only storage device is a single floppy disk drive, you
  293. will need to create a minimal Workbench disk that will allow you to boot up
  294. your machine and run JACOsub on the same disk.  The scripts directory
  295. contains a Shell script called MakeWB that will create a minimal Workbench
  296. disk for you.
  297.  
  298. To make a minimal Workbench disk, follow these steps:
  299.  
  300. 1.  Make a copy of your original Commodore-issue Workbench disk.
  301.  
  302. 2.  Boot up from it.
  303.  
  304. 3.  Copy MakeWB to this disk.
  305.  
  306. 4.  Execute MakeWB from a Shell prompt by typing this line:
  307.     makewb df0:
  308.     (assuming df0: is the name of your floppy drive; some Amigas use fd0:).
  309.  
  310. 5.  The script will copy the necessary files to RAM: and then ask you to
  311.     insert a formatted floppy disk in the drive.  After you do this, it
  312.     will copy the files needed for a minimal Workbench boot disk from RAM:
  313.     to the blank disk.  The new disk should be about 30% full.
  314.  
  315. After you have made your boot disk, you should have enough space on it to
  316. copy the files in JACOsub's main directory to the root of your new disk,
  317. and JACOsub's fonts to the new disk's fonts: directory.  You will probably
  318. not have enough room to copy the documentation.
  319.  
  320.  
  321. 5.  INTERACTIONS WITH OTHER SOFTWARE AND HARDWARE
  322. =================================================
  323.  
  324. Beta Versions of AmigaDOS:
  325.  
  326.    Avoid.  In particular, a beta version of AmigaDOS 2.1 has been known
  327.    to result in strange "snow," or random flecks of color, appearing on
  328.    the screen while JACOsub plays a script.
  329.  
  330. Directory Opus 4.0:
  331.  
  332.    DO NOT use JACOsub with Directory Opus 4.0!  This version of Directory
  333.    Opus has some known problems that will cause you much grief if you try
  334.    to run JACOsub with it.  You should probably avoid directory utilities
  335.    altogether when running JACOsub!
  336.  
  337. EPU, PowerPacker, and other filesystem compression utilities:
  338.  
  339.    File compressors used to give JACOsub problems before version 1.9 if
  340.    the compressor was set to report the compressed sizes of files, rather
  341.    than the original, uncompressed size.  This no longer matters; disk
  342.    compression should cause no trouble.
  343.  
  344. Text editors:
  345.  
  346.    Some users have reported that certain text editors, when run in the
  347.    background while JACOsub is running, will mess up time events.  TxEd
  348.    causes no problems at all.  Other users have reported no problems with
  349.    CED.  In any case, it is probably a good idea to shut down unnecessary
  350.    tasks before running ANY timing-critical application such as JACOsub.
  351.  
  352. req.library:
  353.  
  354.    Req.library seems to have a problem handling directory names that
  355.    contain spaces.  It's a good idea to avoid spaces in file names anyway.
  356.    You should have either asl.library or req.library in your libs:
  357.    directory.  The program should still work fine without these, however.
  358.    Warning:  There have been instances of req.library trashing memory
  359.    location $00000078 (in the zero-page memory area) which is dangerous for
  360.    AmigaDOS.  If your computer crashes right before a file requester should
  361.    appear, the fault is with req.library, not JACOsub.  JACOsub will use
  362.    asl.library if it can be found.
  363.  
  364. reqtools.library:
  365.  
  366.    Highly recommended!  The patch utility that comes with reqtools.library
  367.    patches req.library, asl.library, and arp.library to use features in
  368.    reqtools.library.  It fixes the problem with req.library described
  369.    above.  Reqtools.library makes your Amiga (and JACOsub) significantly
  370.    more pleasant to use.
  371.  
  372.    HOWEVER, you should NOT use rexxreqtools.library.  Rexxreqtools.library
  373.    has been observed to cause inexplicable crashes with JACOsub.
  374.  
  375. CPUBlit:
  376.  
  377.    Highly recommended for fast Amigas.  This speeds up basic blitter copy
  378.    operations.  ftp://ftp.wustl.edu/pub/aminet/util/boot/CpuBlit.lha
  379.  
  380. VideoTitler:
  381.  
  382.    Recommended.  VideoTitler can do some cool effects that JACOsub can't.
  383.    The authors of JACOsub and VideoTitler have cooperated to get the two
  384.    programs to communicate with each other through ARexx.  Check it out.
  385.    It should be available on any Aminet site.
  386.  
  387. Genlocks:
  388.  
  389.    In general, be sure all video sources are off, and your genlock is not
  390.    trying to gain a lock on anything, when you boot up your computer.
  391.    Genlocks affect the Amiga's internal clocking, and can cause timing
  392.    instabilities if you power everything up in the wrong order.  GVP
  393.    genlocks seem to be especially fussy about how they are brought online.
  394.  
  395.    GVP users: load IFF files with JACOsub at your own risk.  As of 1993,
  396.    there is an incompatibility between the GVP and the AmigaDOS IFF loader
  397.    routines.  Contact Great Valley Products for more information and
  398.    updated software.
  399.  
  400.    SuperGen users should have at least version 2.0 of the supergen.library
  401.    and copinit.library.  See the GENLOCK SUPPORT section below for details.
  402.  
  403.    The Rendale 8802 FMC NTSC genlock is known to slow down the internal
  404.    timer quite drastically on the Amiga 500, rendering it useless for
  405.    playing timed scripts.  This genlock works OK on the A1200, however.  At
  406.    this time (March 1996) the manufacturer is aware of the problem.
  407.  
  408. GVP 1230+ Turbo Series II accelerator:
  409.  
  410.    If you have problems with mysterious lockups, or random pixels appearing
  411.    on the screen, try re-seating the chips.  If that doesn't work, then
  412.    disable the data cache using the CPU NODATACACHE AmigaDOS command.
  413.  
  414.  
  415. 6.  GENLOCK SUPPORT
  416. ===================
  417.  
  418. SuperGen (Digital Creations)
  419. --------
  420.  
  421. JACOsub allows your scripts to control the faders on a SuperGen genlock.
  422. You need to have supergen.library and copinit.library in your libs:
  423. directory to take advantage of this feature.  These libraries are available
  424. from the libs directory of your Digital Creations SuperGen software disk.
  425. SUPERGEN.LIBRARY VERSIONS LESS THAN 2.0 WILL NOT WORK WITH JACOsub.
  426.  
  427. If your SuperGen library is too old, your fades will look jittery.  Update
  428. your SuperGen library as soon as possible.
  429.  
  430. JACOsub will not assume control over the SuperGen until it must execute a
  431. fader command.  From that point on, the genlock will be under software
  432. control until the script play terminates, and then control will be returned
  433. to manual mode.
  434.  
  435. Warning!  DO NOT BOOT UP YOUR AMIGA WITH A SIGNAL PRESENT ON THE SUPERGEN'S
  436. VIDEO INPUT!!  Doing so will adversly affect the Amiga's system clock,
  437. which will cause your scripts to run erratically or much too fast!
  438.  
  439. See the G directive in the Script Format Specification documentation
  440. JScripts.doc, for information on controlling the SuperGen.  Other genlocks
  441. will be supported as software and documentation becomes available to the
  442. author.
  443.  
  444. GVP Genlock (Great Valley Products)
  445. -----------
  446.  
  447. Dissolves with the GVP G-Lock must be controlled through ARexx.  JACOsub
  448. will look for the ARexx script "gvpfade.jsrx" in the current directory, a
  449. "rexx" subdirectory under the current directory, and in REXX:, and copy the
  450. script to ram:glfade.jsrx for faster execution.  This script is currently
  451. not provided.  See the file ARexx.doc for specifications of this script.
  452. If you create such a script, please send it to us!
  453.  
  454. If you have a GVP Genlock, PLAY SCRIPTS THAT LOAD IFF GRAPHICS AT YOUR OWN
  455. RISK!  Your Amiga WILL VERY LIKELY crash!  Great Valley Products says that
  456. the normal AmigaDOS IFF loading routines cause problems when the GVP is in
  457. operation.  Contact GVP for updated software.  Setting GENLOCK to GVP in
  458. your JACOsub.cfg file will cause a compile-time warning to be issued if a
  459. script attempts to load an IFF file.
  460.  
  461. Video Toaster (NewTek)
  462. -------------
  463.  
  464. The first paragraph under "GVP Genlock) above applies to the Video Toaster
  465. also, only the script should be named "toasterfade.jsrx."
  466.  
  467. General Information
  468. -------------------
  469.  
  470. Warning!  The genlock may sometimes show things that do not appear on the
  471. RGB display.  Some examples we discovered:
  472.  
  473.    A vertical line appears on the right edge of genlocked display, but not
  474.    on the RGB display.  The solution is to make sure the horizontal screen
  475.    size is a multiple of 32, such as 640, 672, or 704.  Digital Creations
  476.    tells us that this line won't appear on your videotape, but we suspect
  477.    they're talking about a different phenomenon.  JACOsub won't let you
  478.    specify screen widths that are not a multiple of 32.
  479.  
  480.    Little pieces of characters from the left side of the screen appear
  481.    on the right edge.  This happens when a character's kern setting causes
  482.    the left edge of the screen to clip off a pixel or two, as in the 'W'
  483.    and 't' of the 36-pixel JACOsub font.  You can see this when you run
  484.    the demo script after changing the left margin to 0% by inserting the
  485.    line #HL0 at the top of the script.  Solution:  Use the HL1 directive
  486.    instead of HL0, to provide a few pixels of margin space.  This will keep
  487.    kerned characters from going past the left edge of the display.
  488.  
  489.  
  490. 7.  AREXX SUPPORT
  491. =================
  492.  
  493. If you have ARexx, JACOsub will open an ARexx port called 'JACOsub'.  You
  494. can use a different program (such as SCALA for example) to issue a number
  495. of commands to JACOsub, and you can have JACOsub execute ARexx scripts
  496. while a JACOsub script is playing.  For more information, see the file
  497. ARexx.doc.
  498.  
  499.  
  500. 8.  JCONVERT SCRIPT CONVERSION UTILITY
  501. ======================================
  502.  
  503. Although JACOsub can read directly TurboTitle and Phoenix scripts, they
  504. won't be able to use many of JACOsub's advanced features.  If you need text
  505. with non-sequential, overlapping time ranges, or if you need to control the
  506. positioning or attributes of the text, or if you want to play a Panimator
  507. or MacSubtitler script with JACOsub, you must convert the script to the
  508. JACOsub script format.
  509.  
  510. Converting scripts to JACOsub format is simple.  It can be done through the
  511. AmigaDOS Shell or through Workbench.  The Shell command is
  512.  
  513.    jconvert [-v[erbose]] scriptname1.ext [scriptname2.ext] ...
  514.  
  515. where .ext can be:
  516.    .tts (TurboTitle)
  517.    .pjs (Phoenix Japanimation Society)
  518.    .tim (Generic)
  519.    .pan (Panimator)
  520.    .sub (Subtitle)
  521.    .zeg (ZeroG)
  522.    .scr (MacSubtitler)
  523.  
  524. The optional -v or -verbose switch causes jconvert to echo its output to
  525. the screen as it writes the new file.
  526.  
  527. To run jconvert from Workbench, you can click on its icon twice.  A file
  528. requester will appear, allowing you to select a file to convert.  If you
  529. have SCRIPTPATH specified in JACOsub.cfg, jconvert will use this as the
  530. starting directory for the file requester.
  531.  
  532. Or, if you need to convert multiple scripts, you may multiply select your
  533. script icons (clicking while holding down the SHIFT key) ending with a
  534. double-click on the jconvert icon.
  535.  
  536. Jconvert will read in the script, and write out a new script file called
  537. scriptname.js which will be in JACOsub format.  Then you can modify
  538. scriptname.js to take advantage of JACOsub's advanced features.
  539.  
  540. Source code for jconvert is public domain, and available separately.  It
  541. should work for any computer or operating system.  If you need it, write to
  542. the author, check your local BBS, or call Anime Central BBS (see
  543. information at the end of this document).
  544.  
  545. NOTICE:  If you have a script that JACOsub can read directly without prior
  546. conversion (.tts, .pjs., .tim), then you should let JACOsub try to read and
  547. play your script once before converting it with jconvert, because JACOsub
  548. can inform you of potential problems, but jconvert cannot.  Jconvert does
  549. not analyze your scripts; it simply converts them blindly.  The only
  550. exception is when converting TurboTitle scripts, jconvert will correct
  551. overlapping time ranges by shortening the previous line's end time to be
  552. equal to the current line's start time.
  553.  
  554.  
  555. 9.  JACOsub SCRIPT FILE FORMAT SPECIFICATION
  556. ============================================
  557.  
  558. See the textfile JScripts.doc for a complete description of the JACOsub
  559. script file format.
  560.  
  561. About those 3rd-party file formats
  562. ----------------------------------
  563.  
  564. Robert Jenks, the author of TurboTitle, made an excellent suggestion in his
  565. documentation, that the TurboTitle format should be adopted as a standard
  566. for future software.  JACOsub is compatible with TurboTitle files, but the
  567. TurboTitle format was just not flexible enough for our needs.  We needed to
  568. use SMPTE time units, we needed to control color, style, and positioning of
  569. text, we needed to insert comments in the script and inside the text, and
  570. we needed no restrictions on how time events were sequenced.  (We also
  571. needed something that displayed text faster and more cleanly, but that had
  572. nothing to do with the file format.)
  573.  
  574. The preceding paragraph is not meant to be critical of Mr. Jenks' work.
  575. TurboTitle was a fine program for its time, and it served to provide some
  576. inspirational influence for JACOsub.
  577.  
  578. The JACOsub script file format is the most flexible yet developed.  Scripts
  579. can be as simple as TurboTitle scripts, containing only timing numbers and
  580. text, or you can go all out with global commands and complex formatting
  581. directives.
  582.  
  583. Following the example of TurboTitle's author:  Please, if you're a
  584. programmer, please adopt the JACOsub format standard for future titling
  585. software products.  The format is flexible enough to evolve and grow (and
  586. it certainly has done so since the program's inception), so if you have
  587. suggestions for improvements or changes, please let the author know.
  588.  
  589. And especially, if you want JACOsub to support another file format, send
  590. the specifications and the author will try to work it into either the
  591. program itself or the jconvert utility.
  592.  
  593.  
  594. 10.  SHAREWARE REGISTRATION / COMMERCIAL LICENSING
  595. ==================================================
  596.  
  597. Please refer to the file register.doc.
  598.  
  599.  
  600.  
  601. 11.  LEGAL DISCLAIMER
  602. =====================
  603. (Shamelessly adapted from Haventree's EasyFlow documentation)
  604.  
  605. We don't claim JACOsub is good for anything -- if you think it is, great,
  606. but it's up to you to decide.  If JACOsub doesn't work: tough.  If you
  607. lose a million because JACOsub messes up, it's you that's out the million,
  608. not us.  If you don't like this disclaimer: tough.  We reserve the right
  609. to do the absolute minimum provided by law, up to and including nothing!
  610.  
  611. This is basically the same disclaimer that comes with all other software
  612. packages, but Ours is in plain English and Theirs is in Legalese.
  613.  
  614. Additional disclaimer:  The author will attempt to update the software as
  615. needed, but is not obligated to do so (but so far he has a pretty good
  616. record).
  617.  
  618.  
  619.  
  620. 12.  SUPPORT, TECHNICAL QUESTIONS, SUGGESTIONS, BUG REPORTS
  621. ===========================================================
  622.  
  623. You can contact the author, Alex Matulich, by mail at the address in
  624. section 2 of this file.  Alex may be reached via email, using these
  625. addresses:
  626.  
  627.    Internet:  matulich_a@SEAA.NAVSEA.NAVY.MIL
  628.               alex@bilver.oau.org (should automatically forward)
  629.               Alex.Matulich@animece.oau.org (last resort)
  630.  
  631.     Fidonet:  1:363/137, name "Alex Matulich" (last resort)
  632.  
  633. Support BBS:  Anime Central 407-645-2241, N-8-1, 28,800 maximum baud
  634.               Fidonet address 1:363/137.
  635.               The latest version of JACOsub, plus a fairly massive
  636.               collection of timed scripts contributed by JACOsub users,
  637.               are in the JACOsub Support file area.
  638.  
  639.               Please do not ask questions of the Sysop regarding JACOsub!
  640.               Instead please direct all questions to Alex Matulich.
  641.  
  642. Email server: Anime Central BBS has an email server with which you may
  643.               request the latest version of JACOsub, scripts, and Anime-
  644.               related material to be sent to you through email.  To get
  645.               started, simply send email to ftpmail@animece.oau.org.  In
  646.               the body of your message put this single line:
  647.  
  648.               send allfiles.lzh
  649.  
  650.               This is a complete listing of files on Anime Central.  The
  651.               archive will be sent to you in uuencoded format, so you will
  652.               require a uudecode utility to convert it to usable form.  You
  653.               will also need LZ or LHA to extract the contents of .lzh or
  654.               .lha archives.
  655.  
  656.               IMPORTANT:  PLEASE LIMIT YOUR FTPMAIL REQUESTS TO LESS THAN
  657.               ----------> 500 K PER DAY.  Abusing this service will cause
  658.                           it to disappear forever, for everyone!
  659.  
  660.               JACOsub software and scripts are in the JACOsub file area.
  661.               New versions of JACOsub will always have a file name of the
  662.               form jcosub##.lzh, where ## is the version number; for
  663.               example, version 2.5 would be jcosub25.lzh.
  664.  
  665. IMPORTANT:  WHEN SUBMITTING A BUG REPORT, BE SURE THE PROBLEM IS REPEATABLE
  666. AND SPECIFY THE CONDITIONS UNDER WHICH THE PROBLEM OCCURRED.  Too many
  667. people report problems like "I got an error message when I tried to play my
  668. script" with no other information.  This kind of report helps nobody.  What
  669. version of JACOsub?  What version of AmigaDOS?  What kind of computer?
  670. What were you doing prior to noticing the problem?  Can you reproduce it
  671. and isolate it enough for ME to be able to do the same?
  672.  
  673. If you encounter a problem, try to isolate it.  If the problem is being
  674. caused by something in your script, send the author a small sample script
  675. with your bug report that demonstrates the problem.  Try running the
  676. program on another machine -- if it runs fine on another machine, try to
  677. determine what's different about your setup that's causing the trouble.
  678. And try to describe the bug as completely as possible in your report.
  679.  
  680.  
  681. 13.  KNOWN BUGS -- PLEASE HELP
  682. ==============================
  683.  
  684. From time to time a problem comes up that completely mystifies me.  The
  685. purpose of this section is to list problems reported by users which I
  686. cannot reproduce.  If you find a way to reproduce them reliably, PLEASE
  687. let me know (my addresses are at the end of section 2 of this document).
  688. Please provide as complete a description as possible, as described in the
  689. previous section.
  690.  
  691. 1.  The Color Cycle effect will lock up only on AGA machines when trying
  692.     to cycle an imported graphic while playing a script with either 5 or
  693.     6 video buffers.  It works for all other combinations.
  694.  
  695. 2.  When attempting to play a script, sometimes the following error
  696.     message appears:  "Unable to create temporary ... RastPort for font
  697.     outlines or shadows."  This messge can appear even if the computer has
  698.     sufficient video memory.  The only known solutions are to re-start
  699.     JACOsub, or re-boot, and try again.  I myself have not been able to
  700.     reproduce this bug.  I must have done something in version 2.4 or 2.5
  701.     to fix it, because it has rarely shown up since then.
  702.  
  703. 3.  I have one isolated report of titles flashing up on the screen only
  704.     momentarily, regardless of start and stop times, when trying to play a
  705.     script converted from TurboTitle, under AmigaDOS 1.3 on an Amiga 500,
  706.     when the timer is set to "Event" ("Polled" works fine).
  707.  
  708. 4.  Enforcer hits -- Please inform me of any you encounter.  They should
  709.     be eliminated by now, as far as I know.  Nearly all found so far have
  710.     been harmless errors involving reading from illegal memory addresses
  711.     (like dereferencing a structure pointer set to NULL, for example).
  712.  
  713.  
  714. If you're still reading this far, thank you for using JACOsub.
  715.  
  716. End of Overview.doc.
  717.